Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

ENH: Standardize and Cache Random Seeds #745

Merged
merged 12 commits into from
Oct 24, 2023

Conversation

nyoungbq
Copy link
Contributor

Naming Conventions

Naming of variables should descriptive where needed. Loop Control Variables can use i if warranted. Most of these conventions are enforced through the clang-tidy and clang-format configuration files. See the file complex/docs/Code_Style_Guide.md for a more in depth explanation.

Filter Checklist

The help file complex/docs/Porting_Filters.md has documentation to help you port or write new filters. At the top is a nice checklist of items that should be noted when porting a filter.

Unit Testing

The idea of unit testing is to test the filter for proper execution and error handling. How many variations on a unit test each filter needs is entirely dependent on what the filter is doing. Generally, the variations can fall into a few categories:

  • 1 Unit test to test output from the filter against known exemplar set of data
  • 1 Unit test to test invalid input code paths that are specific to a filter. Don't test that a DataPath does not exist since that test is already performed as part of the SelectDataArrayAction.

Code Cleanup

  • No commented out code (rare exceptions to this is allowed..)
  • No API changes were made (or the changes have been approved)
  • No major design changes were made (or the changes have been approved)
  • Added test (or behavior not changed)
  • Updated API documentation (or API not changed)
  • Added license to new files (if any)
  • Added example pipelines that use the filter
  • Classes and methods are properly documented

@nyoungbq nyoungbq requested review from imikejackson and removed request for imikejackson October 18, 2023 17:17
@nyoungbq nyoungbq marked this pull request as draft October 18, 2023 17:21
@nyoungbq nyoungbq marked this pull request as ready for review October 19, 2023 20:16
@nyoungbq nyoungbq requested a review from imikejackson October 19, 2023 20:16
@imikejackson imikejackson enabled auto-merge (squash) October 24, 2023 16:16
@imikejackson imikejackson self-requested a review October 24, 2023 18:35
@imikejackson imikejackson merged commit f185948 into BlueQuartzSoftware:develop Oct 24, 2023
@nyoungbq nyoungbq deleted the enh/seed_caching branch October 24, 2023 20:16
imikejackson added a commit to imikejackson/simplnx that referenced this pull request Oct 20, 2024
…artzSoftware#745)

* Feature clustering seed updates
* Add Bad Data seed updates
* K Filter seed updates
* Uncertain grid seed updates
* Merge twins seed updates
* Reorganize scalar segment features feature ids randomization
* Initialize Data Randomness Rework and Seed Updates
* Standardize Id Randomization to use a consistent seed
* Point Sample Triangle Geometry Seeding Updates

Signed-off-by: Michael Jackson <[email protected]>

---------

Signed-off-by: Michael Jackson <[email protected]>
Co-authored-by: Michael Jackson <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants